home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / iRegion.h < prev    next >
C/C++ Source or Header  |  2002-01-14  |  2KB  |  78 lines
  1. //
  2. // (c) 2000 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // iRegion.h
  5. //
  6. // Package API for I-War 2 regions.
  7. //
  8. // Revision control information:
  9. //
  10. // $Header: /iwar2/packages/iRegion.h 3     4/10/00 13:39 Brett $
  11. //
  12.  
  13. #include "Flux.h"
  14.  
  15. #ifdef FLUX_COMPILE
  16.  
  17. FLUX_DECLARE_EXTENSION(iRegion);
  18.  
  19. #ifdef FLUX_LIB
  20. #if _MSC_VER >= 1000
  21. #pragma comment( lib, "iregion" )
  22. #endif // _MSC_VER >= 1000
  23. #endif // FLUX_LIB
  24. #else
  25.  
  26. // Dependencies ///////////////////////////////////////////////////////////////
  27.  
  28. uses Sim;
  29.  
  30. // Type definitions ///////////////////////////////////////////////////////////
  31.  
  32. // Region handle
  33. handle hregion : hobject;
  34.  
  35. // Regions API ////////////////////////////////////////////////////////////////
  36.  
  37. //
  38. // hregion iRegion.CreateLDSI
  39. //
  40. // Create an LDSI region centred on the given sim.
  41. //
  42. prototype hregion iRegion.CreateLDSI( hsim centre, float radius );
  43.  
  44. //
  45. // hregion iRegion.CreateTrafficControl
  46. //
  47. // Create a traffic control region centred on the given sim. This consists of
  48. // an LDS inhibit field and a port-speed limit.
  49. //
  50. prototype hregion iRegion.CreateTrafficControl( hsim centre, 
  51.                                                 float radius, 
  52.                                                 float speed_limit );
  53.  
  54. //
  55. // int iRegion.SimCount( hregion region )
  56. //
  57. // Returns the number of sims in this regions
  58. //
  59. prototype int iRegion.SimCount( hregion region );
  60.  
  61. //
  62. // set iRegion.NthSim
  63. //
  64. // Returns the Nth Sim in this region
  65. //
  66. prototype hsim iRegion.NthSim( hregion region, int nth );
  67.  
  68. //
  69. // iRegion.Destroy
  70. //
  71. // Destroy the given region
  72. //
  73. prototype iRegion.Destroy( hregion region );
  74.  
  75. // EOF ////////////////////////////////////////////////////////////////////////
  76.  
  77. #endif // FLUX_LIB
  78.